/**
 * Copyright (c) 2021-Now http://faasadmin.com All rights reserved.
 * No deletion without permission, or be held responsible to law.
 */

package com.faasadmin.faas.addonss.admin.admin.service.codegen;


import com.faasadmin.faas.services.tool.dal.dataobject.codegen.ToolCodegenColumnDO;
import com.faasadmin.faas.services.tool.dal.dataobject.codegen.ToolCodegenTableDO;
import com.faasadmin.faas.services.tool.vo.codegen.ToolCodegenBatchUpdateReqVO;
import com.faasadmin.faas.services.tool.vo.codegen.ToolCodegenCreateListReqVO;
import com.faasadmin.faas.services.tool.vo.codegen.ToolCodegenUpdateReqVO;
import com.faasadmin.faas.services.tool.vo.codegen.table.ToolCodegenTablePageReqVO;
import com.faasadmin.faas.services.tool.vo.codegen.table.ToolDatabaseTableRespVO;
import com.faasadmin.framework.common.pojo.PageResult;

import java.util.List;
import java.util.Map;

/**
 * 代码生成 Service 接口
 *
 * @author faasadmin
 */
public interface ToolCodegenService {

    /**
     * 基于数据库的表结构，创建代码生成器的表定义
     *
     * @param userId 用户编号
     * @param reqVO 表信息
     * @return 创建的表定义的编号数组
     */
    List<Long> createCodegenList(Long userId, ToolCodegenCreateListReqVO reqVO);

    /**
     * 更新数据库的表和字段定义
     *
     * @param updateReqVO 更新信息
     */
    void updateCodegen(ToolCodegenUpdateReqVO updateReqVO);

    /**
     * 批量更新数据库的表和字段定义
     *
     * @param updateReqVO 更新信息
     */
    void batchUpdateCodegen(ToolCodegenBatchUpdateReqVO updateReqVO);

    /**
     * 基于数据库的表结构，同步数据库的表和字段定义
     *
     * @param tableId 表编号
     */
    void syncCodegenFromDB(Long tableId);

    /**
     * 删除数据库的表和字段定义
     *
     * @param tableId 数据编号
     */
    void deleteCodegen(Long tableId);

    /**
     * 批量删除数据库的表和字段定义
     *
     * @param tableIdS 数据编号
     */
    void batchDeleteCodegen(List<Long> tableIdS);

    /**
     * 获得表定义分页
     *
     * @param pageReqVO 分页条件
     * @return 表定义分页
     */
    PageResult<ToolCodegenTableDO> getCodegenTablePage(ToolCodegenTablePageReqVO pageReqVO);

    /**
     * 获得表定义
     *
     * @param id 表编号
     * @return 表定义
     */
    ToolCodegenTableDO getCodegenTablePage(Long id);

    /**
     * 获得指定表的字段定义数组
     *
     * @param tableId 表编号
     * @return 字段定义数组
     */
    List<ToolCodegenColumnDO> getCodegenColumnListByTableId(Long tableId);

    /**
     * 执行指定表的代码生成
     *
     * @param tableId 表编号
     * @return 生成结果。key 为文件路径，value 为对应的代码内容
     */
    Map<String, String> generationCodes(Long tableId);

    /**
     * 批量生成代码
     * @param tableIds
     * @return
     */
    byte[] batchGenerationCodes(List<String> tableIds);

    /**
     * 获得数据库自带的表定义列表
     *
     *
     * @param dataSourceConfigId 数据源的配置编号
     * @param name 表名称
     * @param comment 表描述
     * @return 表定义列表
     */
    List<ToolDatabaseTableRespVO> getDatabaseTableList(Long dataSourceConfigId, String name, String comment);


    /**
     * 获取表数据
     * @param tableIds 表ID列表
     * @return
     */
    List<ToolCodegenTableDO> getCodegenTableList(List<Long> tableIds);

}
